﻿namespace Sgr.DataCategories.Stores
{
    /// <summary>
    /// 本地行政区划存储接口
    /// </summary>
    public interface IAdmDivStore : IDisposable
    {
        /// <summary>
        /// 获取或添加行政区划数据。
        /// 如果本地已存在则直接返回，否则通过 valueFactory 获取并添加。
        /// </summary>
        /// <param name="valueFactory">用于获取行政区划数据的委托</param>
        /// <param name="cancellationToken">取消操作的标记</param>
        /// <returns>行政区划集合</returns>
        Task<IEnumerable<AdmDiv>> GetOrAddAsync(
            Func<CancellationToken, Task<IEnumerable<AdmDiv>>> valueFactory,
            CancellationToken cancellationToken = default);

        /// <summary>
        /// 刷新本地行政区划数据。
        /// </summary>
        /// <param name="items">新的行政区划数据集合</param>
        /// <param name="cancellationToken">取消操作的标记</param>
        Task RefreshAsync(
            IEnumerable<AdmDiv> items,
            CancellationToken cancellationToken = default);

        /// <summary>
        /// 清空本地行政区划数据。
        /// </summary>
        /// <param name="cancellationToken">取消操作的标记</param>
        Task ClearAsync(
            CancellationToken cancellationToken = default);
    }
}